home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / nc_b10.zip / SYSOP.DOC < prev    next >
Text File  |  1992-01-14  |  14KB  |  275 lines
  1.  
  2.    ╒═══════════════════════════════════════════════════════════════╕
  3.    │                                                               │
  4.    │               ╔════                                           │
  5.    │               ║                                               │
  6.    │               ╚═══╗     ║       ║                             │
  7.    │                   ║ ║ ║ ╠═╗ ═╦═ ║                             │
  8.    │               ════╝ ╚═╣ ╚═╝ ═╩═ ╚═ WARE                       │
  9.    │                       ║  by boB Gage                          │
  10.    │                     ══╝  Available on Sybil BBS               │
  11.    │                          (703) 951-2708  HST DS               │
  12.    │                                                               │
  13.    │          S Y S O P   D O C U M E N T A T I O N                │
  14.    ╘═══════════════════════════════════════════════════════════════╛
  15.  
  16.  
  17.  
  18. ========================[  Setting Up NameChng  ]========================
  19.  
  20. In ALL batch files, NameChng and NameChk should ALWAYS be called from the same
  21. directory.  The smaller this directory, the fast NameChk will run, so I
  22. suggest using a seperate directory for NameChng.  This directory will be used
  23. for flag and save files.  You should NEVER delete any *.SNC or *.ALI file from
  24. this directory!!!!  This directory SHOULD NOT be on a RAM drive or other
  25. easily lost storage device.  Using a RAMdrive VIRTUALLY GUARANTEES eventual
  26. corruption of your USERS file, locking a user into their alias until you
  27. manually restore them (see BETA.DOC for details)
  28.  
  29. Setting up NameChng is a 5 to 7 step process:
  30.  
  31. 1) Write the batch file (or files) to run the door
  32. 2) Include the batch file(s) in your DOORS.DAT file
  33. 3) Make the alias text file
  34. 4) Modify or create $$LOGOFF.BAT files for each node
  35. 5) Modify NameChng.CFG to suit your needs
  36. 6) Optionally modify the various TXT files
  37. 7) Optionally add NameIndx to your event
  38.  
  39. 1) - Write the batch file (or files) to run the door
  40.  
  41. There are two options for setting up your door batch files.  You can have a
  42. single door that the user calls with a parameter of either REAL or ALIAS (ie
  43. NameChng Alias to get into the alias and  NameChng Real to switch back) OR
  44. You can set up two doors, one to enter the alias and one to leave it.
  45. Personally I'm using both approaches with different alias files; a single
  46. batch, NameChng, calls using my adult & "other" aliases file, and two batches,
  47. D&D and LeaveD&D, operate using my D&D players/characters alias file.
  48.  
  49. Note that using the two batch file option locks the user away from the REQUEST
  50. command and any commands later added.
  51.  
  52. The format for calling NameChng.EXE is:
  53.     NameChng  <file> ALIAS  [#]            -  change to alias name
  54.     NameChng  <file> REAL                  -  change to real name
  55.     NameChng  <file> REQUEST Alias Name    - request alias
  56.     NameChng  <file> VERIFY Alias Name     - sysop only, verify alias
  57.     NameChng  <file> REJECT Alias Name     - sysop only, reject alias
  58.  
  59. The first two parameters are required!  <file> is the alias text file,
  60. discussed below.   The second parameter is the command NameChange is to
  61. execute, and these commands ARE configurable in the NameChng.CFG file.
  62.  
  63. An OPTIONAL parameter is used on the ALIAS line to implement multiple
  64. aliases.  If a number is given here, it is the alias number to use.  For
  65. example, if a person had three aliases defined on your system (all with the
  66. same real name), he could switch to the third one with NameChng Alias 3.
  67.  
  68. The single batch file, NameChng, looks like this:
  69. o:
  70. CD \NAMECHNG
  71. NAMECHNG  ADULTS %PCBDOOR%
  72. exit             ^^^^^^^^^^ that's PCB's command stack variable
  73.                             which should include either REAL or ALIAS
  74.                             and an optional numeric parameter OR
  75.                             the word REQUEST and the desired alias
  76.  
  77.  
  78. The D&D conference batch files look like this:
  79. File: D&D
  80. o:
  81. cd \namechng
  82. namechng DNDPLAY Alias
  83. exit                   ^^^^^  Notice the dropped 3rd parameter, it
  84.                               uses first alias encountered in file
  85.                               by default.  Including %PCBDOOR%
  86.                               here would enable players with 2
  87.                               or more characters to switch
  88.                               between names by typing D&D #,
  89.                               where # is the character number.
  90. File: LEAVED&D
  91. o:
  92. cd \namechng
  93. namechng DNDPLAY Real
  94. exit
  95.  
  96.  
  97. Notes:  When using the two batch file method described above, you lose the
  98. ability for the REQUEST, VERIFY, and REJECT commands unless you install
  99. seperate batch files for these as well (not suggested).  In this case, modify
  100. the NOALIAS.TXT file to tell the user the proper alias registration method
  101. (ie C)omment to sysop).
  102.  
  103.    Using the single batch file method gives you complete access to all
  104. existing and possible future commands through the %PCBDOOR% environment
  105. variable.
  106.  
  107. 2) - Include the batch files in your DOORS.DAT file
  108.  
  109. After setting up your batch files, add NameChng to your PCBoard door
  110. directories.  NameChng does NOT need any extra files, but should be set up as
  111. a SHELL door, your DOORS.DAT line will look similar to this:
  112.  
  113. NameChng,,42,0,0,P:\DOORBATS\,0,Y
  114.                                ^^^  Shell door!!  Should be YES
  115.  
  116.  
  117. 3) - Make the alias text file
  118.  
  119. The alias files used by NameChng determine who gets what aliases and which
  120. conferences they are allowed in.
  121.  
  122. Here is a sample with comments:
  123.  
  124.          1         2         3        4          5         6
  125. 123456789012345678901234567890123456789012345678901234567890
  126. <Top of File>
  127. !D  27 28           ; Defines group D, conferences 27 & 28 only
  128. !A 56-65 55         ; Defines group A, conference 55-65, 56 is "home"
  129. GEORGE JOHNSON           FISTANTALUS              D      ; Group D alias
  130. TERRY HEIGHT             PRATAR                   D
  131. FISTANTALUS              WILLIAM SMITH                   ; unrestricted alias
  132. CYNTHIA MURRELL          GWYN AP RHYS             D
  133. MARC ZALDIVAR            BOLARON                  D
  134. CHUCK HEIM               BART                     A      ; Group A alias
  135. ROBERT JARRETT           NITEBREED                A
  136. GEORGE STEVENS           RICH MOORE
  137. CHARLIE MOODY            MR. DUDE                 A
  138. MARY STEWART             DAMNIT JANET!            A 23 24  ; Group A + 23 & 24
  139. <End of File>
  140.  
  141. All comments above begin with semi-colons and should NOT be included in the
  142. file used online!
  143.  
  144. The alias file has two types of lines, any line begining with an exclamation
  145. point followed by a letter defines a group of conferences so that it can be
  146. referred to later easily.  In the above example, I defined two groups, D for
  147. D&D characters restricted to the D&D conferences, and A for adult aliases
  148. restricted to ThrobNet.
  149.  
  150. Other lines are real names in columns 1 thru 25, alias name in 26 thru 50, and
  151. conferences allowed starting in column 51.  The first conference allowed (the
  152. "home" conference) will be joined when the alias is assumed.  The group
  153. letters eliminate the need to type the conference numbers over and over, all
  154. aliases marked with a D above can ONLY be used in conferences 27 & 28, and the
  155. user will by joined in 27 when entering the alias.  The ones marked by A are
  156. limited to 55-65, and are joined in conference 56 (THAT's why 55 is listed
  157. last in the series, to make 56 the "home" conference).
  158.  
  159. An alias WITHOUT a conference lockout will be allowed in all conferences (as
  160. in George Stevens' case above).  Additional conferences can be allowed to
  161. individual users on a case-by-case basis (see Mary Stewart's access to
  162. conferences 23 & 24 as Damnit Janet!).
  163.  
  164. Multiple aliases are simple to set up, but are only supported in the
  165. registered version of the program.  Simply have several lines in your alias
  166. file with the same real name.  The user can differentiate between aliases by a
  167. numeric parameter.  The first alias encountered in the file is #1, the second
  168. #2, etc.  If using the one batch file method, no special changes are needed to
  169. implement multiple aliases, but if using the two batch file method, the
  170. %PCBDOOR% variable should be added to the ALIAS call to NameChng.
  171.  
  172.  
  173. 4) - Modify or create $$LOGOFF.BAT files for each node
  174.  
  175. NameChk should be called in the $$LOGOFF.BAT file, and will restore the user's
  176. name & conference registrations back to normal.  The ALL parameter is included
  177. to call from the nightly event and change all users back regardless of node
  178. number.  This is not to replace the call in the $$LOGOFF file, but to catch
  179. user's who may have crashed the system and cause $$LOGOFF not to run.  If
  180. multiple alias files are used, you should call NameChk once for each file.
  181. This is a small and fast file, so calling it a few times will still be pretty
  182. quick. (I get 2 sec runs on a 386 and 6 sec on an XT)
  183.  
  184. The format for calling NameChk.EXE is:
  185.      NameChk  <file> <PCB node number>
  186.      NameChk  <file> ALL  ****  ALL is not yet implemented!
  187.  
  188. Make sure that NameChng and NameChk are ALWAYS run from the same directory, as
  189. it uses save files to store conference registrations and alias flags.  For
  190. this reason, NameChng should NOT be run off of a RAMdrive unless you're
  191. willing to risk USERS file damage in the case of a reboot.
  192.  
  193. ****  Beta Test Version - ALL parameter is not yet implemented, so IF NameChk
  194. call is used in event, it should be done once for each node number.
  195. [Personally I'm not running it in the event at all, if the $$LOGOFF doesn't
  196. get them the first time, it will the second, and NameChk is set up to change
  197. back ALL aliases from the current node, it doesn't assume just one]
  198.  
  199.  
  200. 5) - Modify the NameChng.CFG file to suit your needs
  201.  
  202.    The NameChng.CFG file contains configuration & options information about
  203. your setup that all the NameChange programs use.  The file is a simple text
  204. file, the format is shown below:
  205.  
  206. Line 1:  Name of BBS
  207. Line 2:  Registration Number (or blank)
  208. Line 3:  Path to your PCB\MAIN directory (USERS,CALLER,et al)
  209. Line 4:  Reserved
  210. Line 5:  Reserved
  211. Line 6:  User ALIAS command       Lines 6 - 11 are optional
  212. Line 7:  User REAL command          if left blank, will default to ALIAS,
  213. Line 8:  User REQUEST command       REAL, REQUEST, VERIFY, REJECT, and SHOW.
  214. Line 9:  User VERIFY command
  215. Line 10: User REJECT command
  216. Line 11: User SHOW command
  217.  
  218. The name of your BBS on line 1 must EXACTLY match the name you gave me
  219. for verification or your registration code WILL NOT work.  It IS case
  220. sensitive.  Changing lines 6 thru 11 gives you the ability to completely
  221. customize NameChange to your own needs.  Each line contains a single
  222. word command that the user types to activate that particular function.
  223. ie, by putting FAKE on line 6, you make the command to change to an
  224. alias NAMECHNG FAKE instead of NAMECHNG ALIAS.
  225.  
  226. 6) - Optionally modify the various TXT files
  227.  
  228. ALL of NameChng's user displays are in text files that must reside in the
  229. NameChng directory.  These fully support PCB's @ commands (especially
  230. considering that it's PCBoard that displays them) and can be modified at your
  231. discretion.  The files are:
  232.  
  233.     BADPARAM.TXT - Shown if the parameters given are not correct
  234.     NOALIAS.TXT  - Shown if the user is not listed as a real name or if
  235.                    an alias number beyond those defined is used (ie asking
  236.                    for the third alias when the user only has two)
  237.     ALIAS.TXT    - Shown when the user has been put into the alias
  238.     REAL.TXT     - Shown when the user has been changed to real name
  239.     REQUEST.TXT  - Shown when the user requests an alias
  240.     NOTREG.TXT   - Shown if user is not registered in alias's home conf
  241.  
  242. NameChng will add a single door identification line at the end of the TXT file
  243. when it is displayed.   A blank line will be added before it.
  244.  
  245.  
  246. 7) - Optionally add NameIndx to your event
  247.  
  248. NameIndx is a "trade-off" utility.  A side effect of aliasing on PCBoard is
  249. that messages TO an alias don't cause the mail flags to be set, and also cause
  250. the user to get a "So and so not found, (C)ontinue, (R)etype, ..." error
  251. unless the conference is declared as an ECHO conference.  And even then, the
  252. user has to answer the "Echo message?" prompt, even though the conference may
  253. be local.
  254.  
  255. NameIndx solves that problem by re-building the PCBNDX files with additional
  256. entries from your alias files.  See NameIndx.DOC for documentation on setting
  257. up NameIndx.
  258.  
  259. The reason NameIndx is called a trade-off is that if you do use it, it solves
  260. the problems with mail flags and with message entry.  But there is a side
  261. effect that may confuse your users.  A user will be able to log on using their
  262. alias name, which may lead them to believe they are logged on AS their alias,
  263. but they will really be in their real name.  NameIndx makes multiple
  264. references to the same user record, and PCBoard gets the user name from the
  265. record, NOT from the answer to the logon prompt.
  266.  
  267. So, you decide which problem you want, the mail flags & msg entry problem OR
  268. the logon side-effect.  Personally I feel that NameIndx is the way to go, but
  269. know that others may feel differently, so I left it as a completely seperate
  270. program.
  271.  
  272. Think that's about it, if you have any problems, I can be contacted at Sybil
  273. BBS (703) 951-2708 HST/v32 or through the ThrobAdmin conference on ThrobNet or
  274. the Sysop, Shareware, or Laptop conferences on U'NI-Net/US.
  275.